PDF4Java Reference Documentation
com.o2sol.pdf4java Package / PDFPage Class
Fields Methods


In This Topic
    PDFPage Class Members
    In This Topic

    The following tables list the members exposed by PDFPage.

    Public Constructors
     NameDescription
    Public ConstructorPDFPage ConstructorOverloaded.   
    Top
    Protected Fields
     NameDescription
    Protected FieldcontentStreamContainer (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Top
    Public Methods
     NameDescription
    Public MethodaddAnnotationAdds an annotation to the page.  
    Public MethodaddFieldAdd a form field to the page.  
    Public MethodaddOptionalContentResourceThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodaddPropertyResourceThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodconvertDisplayPointToStandardPointConverts a point from the display coordinate system (origin of coordinate system in top left corner of display page area) to standard PDF coordinate system (origin of coordinate system in bottom left corner of page media box).  
    Public MethodconvertDisplayRectangleToStandardRectangleConverts a rectangle on the page from display coordinate system (origin of coordinate system in top left corner of display page area) to standard PDF coordinate system (origin of coordinate system in bottom left corner of page media box).  
    Public MethodconvertStandardPointToDisplayPointConverts a point from standard PDF coordinate system (origin of coordinate system in bottom left corner of page media box) to display coordinate system (origin of coordinate system in top left corner of display page area).  
    Public MethodconvertStandardRectangleToDisplayRectangleConverts a rectangle on the page from standard PDF coordinate system (origin of coordinate system in bottom left corner of page media box) to display coordinate system (origin of coordinate system in top left corner of display page area).  
    Public MethodgetAnnotationGets the annotation at the specified index.  
    Public MethodgetAnnotationsGets the list of page annotations.  
    Public MethodgetArtBoxGets the art box.  
    Public MethodgetBleedBoxGets the bleed box.  
    Public MethodgetCanvasGets the page canvas.  
    Public MethodgetCloseActionGets the page close action.  
    Public MethodgetColorSpaceResourceThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodgetContentStreamContainerGets the inner COS dictionary. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodgetCosPageGets the COS dictionary asssociated with this object.
    Incorrect manipulation of the information in the COS dictionary can lead to invalid PDF files.  
    Public MethodgetCropBoxGets the crop box.  
    Public MethodgetDocumentGets the PDF document.  
    Public MethodgetFieldGets the form field with the specified name.  
    Public MethodgetFieldsGets the page form fields.  
    Public MethodgetFontResourceThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodgetGraphicsStateResourceThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodgetHeightGets the visual page height.
    The visual height is the height of the page as it is seen on the display. It is always measured on vertical no matter the page rotation.  
    Public MethodgetIsEvaluationMessageAddedThis method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodgetMediaBoxGets the media box.  
    Public MethodgetOpenActionGets the page open action.  
    Public MethodgetOptionalContentGroupGets the optional content group with the specified name.  
    Public MethodgetOptionalContentGroupsGets the list of optional content groups included in the page content.
    This collection is filled automatically with the optional content groups drawn on the page, either when page content is created or when a page is loaded from a source file.  
    Public MethodgetPageFontsGets the set of fonts included in this page.
    This method examines the fonts included in page's resources dictionary. It is possible that not all the fonts are actually used on the page.  
    Public MethodgetPageSizeGets the PDF page size to a predefined value.
    The value returned by this property is matched against predefined page sizes within a certain margin () so the Width and Height properties of the returned object might not match the actual page Width and Height.  
    Public MethodgetParentThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodgetPatternResourceThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodgetPropertyResourceThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public Methodstatic (Shared in Visual Basic)getResourceThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodgetResourcesDictionaryThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodgetRotationGets the rotation angle.  
    Public MethodgetShadingResourceThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodgetTabOrderGets the annotations tab order.  
    Public MethodgetTrimBoxGets the trim box.  
    Public MethodgetUserUnitGets the page user unit.  
    Public MethodgetViewportsGets the page viewports.  
    Public MethodgetWidthGets the visual page width.
    The visual width is the width of the page as it is seen on the display. It is always measured on horizontal no matter the page rotation.  
    Public MethodgetXmpMetadataGets the XMP page metadata.  
    Public MethodgetXObjectResourceThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodloadAnnotationsThis method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodmapMarkedContentIdentifierToStructureElementThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodmergeGraphicsStreamsThis method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodsaveSaves the PDF page.
    The page must be included in a document and the save procedure must be already initiated by a call.  
    Public MethodsaveCanvasSaves the page canvas.
    The page graphics can be composed internally of multiple fragments. If you are working with large vector graphics, such as maps, then you can split the page graphics in fragments and save each fragmment as soon as it is done in order to reduce memory consumption. A graphics fragment is automatically created when method is called.
    The page must be included in a document and the save procedure must be already initiated by a call.  
    Public MethodsaveImagesSaves the images drawn on the PDF page.
    The page must be included in a document and the save procedure must be already initiated by a call.  
    Public MethodsetArtBoxSets the art box.  
    Public MethodsetBleedBoxSets the bleed box.  
    Public MethodsetCanvasPositionSets the position of the page graphics relative to existing page content.
    If the page is newly created this method has no effect since there is no previous content. If the page has been extracted from a PDF file or has been created by loading a PDF file into a then the page graphics can be under the existing page content or on top of existing page content (default).  
    Public MethodsetCloseActionSets the page close action.  
    Public MethodsetCropBoxSets the crop box.  
    Public MethodsetHeightSets the visual page height.
    The visual height is the height of the page as it is seen on the display. It is always measured on vertical no matter the page rotation.  
    Public MethodsetIsEvaluationMessageAddedThis method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodsetMediaBoxSets the media box.  
    Public MethodsetOpenActionSets the page open action.  
    Public MethodsetPageSizeSets the PDF page size to a predefined value.
     
    Public MethodsetRotationSets the rotation angle.
    The accepted values for this method are 0, 90, 180 and 270 degrees.  
    Public MethodsetTabOrderSets the annotations tab order.  
    Public MethodsetTrimBoxSets the trim box.  
    Public MethodsetUserUnitSets the page user unit.  
    Public MethodsetViewportsSets the page viewports.  
    Public MethodsetWidthSets the visual page width.
    The visual width is the width of the page as it is seen on the display. It is always measured on horizontal no matter the page rotation.  
    Public MethodsetXmpMetadataSets the XMP page metadata.  
    Public MethodzInternalMethod43This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod44This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod46This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod47This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod48This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod49This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod50This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod51This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod52This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodzInternalMethod53This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodzInternalMethod54This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodzInternalMethod55This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodzInternalMethod56This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Public MethodzInternalMethod57This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.PDFContentStreamContainer)
    Top
    See Also

    Reference

    PDFPage Class
    com.o2sol.pdf4java Package

     

     

    © 2025 O2 Solutions All Rights Reserved.

    Send comments on this topic.